/*
 * Jpkg - Java library and tools for operating system package creation.
 *
 * Copyright (c) 2007 Three Rings Design, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright owner nor the names of contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.threerings.jpkg.webos;

/**
 * Holds the valid Debian package priorities. Descriptions for the fields come from the Debian Policy Manual.
 * @see <a href="http://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities">Debian Policy Manual</a>
 */
public enum PackagePriority
    implements ControlFileData
{
    /**
     * "Packages which are necessary for the proper functioning of the system (usually, this means
     * that dpkg functionality depends on these packages)."
     */
    REQUIRED ("required"),
    /** "Important programs, including those which one would expect to find on any Unix-like system." */
    IMPORTANT ("important"),
    /** "These packages provide a reasonably small but not too limited character-mode system." */
    STANDARD ("standard"),
    /**
     * "This is all the software that you might reasonably want to install if you didn't know what
     * it was and don't have specialized requirements."
     */
    OPTIONAL ("optional"),
    /**
     * "This contains all packages that conflict with others with required, important, standard or
     * optional priorities, or are only likely to be useful if you already know what they are or
     * have specialized requirements."
     */
    EXTRA ("extra");

    PackagePriority (String name) {
        _name = name;
    }

    // from ControlFileData
    public String getField ()
    {
        return "Priority";
    }

    // from ControlFileData
    public String getFieldValue ()
    {
        return _name;
    }

    /** The string representation for this priority. */
    private final String _name;

}
